api/priceModifiersByName/{name} (Get)

Get	api/priceModifiersByName/{name}

In This Topic

Resource Path: /sites/{company-id}/api/priceModifiersByName/{name}

Uri: https://secure.ontime360.com/sites/{company-id}/api/priceModifiersByName/{name}

Description

Retrieves a single PriceModifier object assigned to a given name.

Parameters

Name	Description	Data Type
name	The name of a PriceModifier as a String.	string

200 Response

The response body is of type PriceModifier.

Returns a comprehensive PriceModifier object.

Overview

PriceModifier

Represents a comprehensive PriceModifier record within the OnTime API.

ID : string

The unique identifier for this PriceModifier record.

Name : string

The name of this PriceModifier.

CustomValue : number

The user-defined custom value assigned to this PriceModifier.

PercentCommissionable : number

The percentage-based value used to determine the commissionable amount for this PriceModifier.

Price : number

The calculated price of this PriceModifier.

Type : string

The pre-defined {OnTime.Extensions.SDK.PriceModifierBase.PriceModifierType} detailing the pricing calculation behavior of this PriceModifier. Available Values: [Other, SignatureCapture, CashOnDelivery, DistanceBasePrice, AdHocCharge, Tax]

Input : string

The pre-defined {OnTime.Extensions.SDK.PriceModifierBase.InputFieldType} detailing the field-specific behavior used when calculating the pricing of this PriceModifier. Available Values: [None, Weight, Quantity, Mileage, Dimensions, Custom, DeclaredValue, BasePrice, Height, Width, Depth, ZoneLookupTable]

Fault Responses

Fault	Description
400	Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
401	Authorization key is invalid or no longer exists.
403	Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.